---
title: MSSQL, SQL Server, Azure
header: Official Drivers
layout: ../../../layouts/MainLayout.astro
---

import RenderConnectionOptions from '../../../components/RenderConnectionOptions.tsx';

# Microsoft SQL Server/Azure Start Guide

## 1. Connections

Connection example:

```json
{
  "name": "MSSQL",
  "server": "localhost",
  "driver": "MSSQL",
  "port": 1433,
  "database": "test_db",
  "username": "sa",
  "askForPassword": false,
  "password": "root(!)Password",
  "connectionTimeout": 15
}
```

### 1.1 Specific Options

MSSQL driver specific options can be passed using `mssqlOptions` settings.

```json
{
  "name": "MSSQL",
  "server": "localhost", // You can use 'localhost\\instance' to connect to named instance
  "driver": "MSSQL",
  "port": 1433,
  "database": "test_db",
  "username": "sa",
  "askForPassword": false,
  "password": "root(!)Password",
  "connectionTimeout": 15,
  "mssqlOptions": {
    ... // options
  }
```

| Option key              | Default Value | Description                                                                                                                                                                                                                  |
| ----------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| abortTransactionOnError |               | A boolean determining whether to rollback a transaction automatically if any error is encountered during the given transaction's execution. This sets the value for XACT_ABORT during the initial SQL phase of a connection. |
| appName                 |               | Application name used for SQL server logging.                                                                                                                                                                                |
| instanceName            |               | The instance name to connect to. The SQL Server Browser service must be running on the database server, and UDP port 1434 on the database server must be reachable.                                                          |
| useUTC                  | `true`        | A boolean determining whether or not use UTC time for values without time zone offset (default: true).                                                                                                                       |
| encrypt                 | `true`        | A boolean determining whether or not the connection will be encrypted.                                                                                                                                                       |
| tdsVersion              | `7_4`         | The version of TDS to use (default: 7_4, available: 7_1, 7_2, 7_3_A, 7_3_B, 7_4).                                                                                                                                            |

You can use any setting defined in See https://github.com/tediousjs/node-mssql/#tedious also extra options defined in Tedious specific options

## Breaking changes

### v0.19.x

- Removed deprecated (v0.17.6) `sqltools.connections[].dialectOptions` in favor of `sqltools.connections[].mssqlOptions`.

<RenderConnectionOptions
  client:only="react"
  exclude={['mysqlOptions', 'oracleOptions', 'socketPath', 'icons', 'pgOptions']}
/>
